Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements: Docs #7

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Improvements: Docs #7

merged 3 commits into from
Jul 8, 2024

Conversation

aaronczichon
Copy link
Member

Description

Added documentation for first usage, also added new workflow to run on every main commit.

Completes

closes #4
closes #5

Type of change

Please select an option

  • Bug fix (non-breaking change which fixes an issue)
  • New Feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Other (please provide a description below)

Testing Instructions

Please provide testing instructions for the reviewer here

  • Manual testing (Please provide the testing instructions)
  • Automated testing

Screenshots

Review Checklist

  • Code follows style & code guidelines
  • Has linked issue
  • Pull request includes description
  • Version and changelog were updated
  • Testing Instructions are provided
  • Tests are verified
  • Commits follow our Conventional Commits guidelines

@aaronczichon aaronczichon merged commit 9e1f495 into main Jul 8, 2024
4 checks passed
@aaronczichon aaronczichon deleted the improvements/docs branch July 8, 2024 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add workflow for main branch Documentation
1 participant